/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 - 2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.projects.toolbox_basics_project.spring.manager;

import java.util.Locale;

import com.genia.toolbox.persistence.exception.PersistenceException;
import com.genia.toolbox.projects.toolbox_basics_project.bean.model.I18nDynamicValue;

/**
 * the manager for {@link I18nDynamicValue}.
 */
public interface I18nDynamicEntityManager
{

  /**
   * returns the translation of this {@link I18nDynamicValue}.
   * 
   * @param i18nDynamicValue
   *          the {@link I18nDynamicValue}.
   * @return the translation of this {@link I18nDynamicValue}.
   * @throws PersistenceException
   *           when an error occured
   */
  public String getTranslation(I18nDynamicValue i18nDynamicValue)
      throws PersistenceException;



  /**
   * set the value of an {@link I18nDynamicValue} for a given {@link Locale}.
   * 
   * @param i18nDynamicValue
   *          the {@link I18nDynamicValue} to modify
   * @param locale
   *          the {@link Locale} to modify
   * @param value
   *          the new value
   * @throws PersistenceException
   *           if an error occured
   */
  public void setValue(I18nDynamicValue i18nDynamicValue, Locale locale, String value)
      throws PersistenceException;

}
